---
title: "List integrations with this business's status"
canonical_url: "https://twominutebilling.com/help/developers/api-reference/integrations/list-integrations-with-this-business-s-status"
---
# List integrations with this business's status

<api-operation method="GET" path="/v1/businesses/{biz}/integrations">
<template v-slot:docs="">

## Path parameters

<table>
<thead>
  <tr>
    <th>
      Parameter
    </th>
    
    <th>
      Type
    </th>
    
    <th>
      Required
    </th>
    
    <th>
      Description
    </th>
  </tr>
</thead>

<tbody>
  <tr>
    <td>
      <code>
        biz
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      <strong>
        yes
      </strong>
    </td>
    
    <td>
      Business id (biz_…)
    </td>
  </tr>
</tbody>
</table>

## Response

<table>
<thead>
  <tr>
    <th>
      Field
    </th>
    
    <th>
      Type
    </th>
    
    <th>
      Description
    </th>
  </tr>
</thead>

<tbody>
  <tr>
    <td>
      <code>
        object
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      The object type; always <code>
        list
      </code>
      
      . One of <code>
        list
      </code>
      
      .
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        data
      </code>
    </td>
    
    <td>
      <code>
        array of object
      </code>
    </td>
    
    <td>
      The rows on this page.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        data.object
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      The object type.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        data.key
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      The integration's key.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        data.label
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      The integration's name as shown.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        data.kind
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      <code>
        push
      </code>
      
      : each matching event becomes one partner call. <code>
        sync
      </code>
      
      : a two-way record sync with its own routes. One of <code>
        push
      </code>
      
      , <code>
        sync
      </code>
      
      .
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        data.category
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      The integration's category. One of <code>
        crm
      </code>
      
      , <code>
        affiliate
      </code>
      
      .
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        data.blurb
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      A one-line description of the integration.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        data.icon
      </code>
    </td>
    
    <td>
      <code>
        object
      </code>
    </td>
    
    <td>
      <code>
        monogram
      </code>
      
       always present; <code>
        src
      </code>
      
       is a dashboard-local asset path when one ships.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        data.connect_method
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      <code>
        api_key
      </code>
      
      : post <code>
        credentials
      </code>
      
       to <code>
        …/connect
      </code>
      
      . <code>
        oauth
      </code>
      
      : the integration's own install flow. One of <code>
        api_key
      </code>
      
      , <code>
        oauth
      </code>
      
      .
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        data.event_types
      </code>
    </td>
    
    <td>
      <code>
        array of string
      </code>
    </td>
    
    <td>
      The events a push integration acts on. Fixed by the integration.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        data.credentials
      </code>
    </td>
    
    <td>
      <code>
        array of object
      </code>
    </td>
    
    <td>
      What a push integration authenticates with, in form order. Post them as <code>
        credentials
      </code>
      
      , keyed by <code>
        key
      </code>
      
      .
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        data.fields
      </code>
    </td>
    
    <td>
      <code>
        array of object
      </code>
    </td>
    
    <td>
      Extra settings, posted as <code>
        config
      </code>
      
      .
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        data.prerequisite
      </code>
    </td>
    
    <td>
      <code>
        object
      </code>
    </td>
    
    <td>
      Something that must be set up outside tmbilling first.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        data.status
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      The business integration's status. One of <code>
        not_connected
      </code>
      
      , <code>
        active
      </code>
      
      , <code>
        disabled
      </code>
      
      , <code>
        reauth_required
      </code>
      
      .
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        data.summary
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      One line, such as the HubSpot portal domain.
    </td>
  </tr>
</tbody>
</table>

## Status codes

<table>
<thead>
  <tr>
    <th>
      Status
    </th>
    
    <th>
      Meaning
    </th>
  </tr>
</thead>

<tbody>
  <tr>
    <td>
      <code>
        200
      </code>
    </td>
    
    <td>
      Success
    </td>
  </tr>
</tbody>
</table>
</template>

<template v-slot:request="">

```bash [Request]
curl "$TMBILLING_URL/v1/businesses/biz_XXXXXXXXXXXX01/integrations" \
  -H "Authorization: Bearer $TMBILLING_API_KEY"
```

</template>

<template v-slot:response="">

```json [200 OK]
{
  "object": "list",
  "data": [
    {
      "object": "business_integration",
      "key": "firstpromoter",
      "label": "FirstPromoter",
      "kind": "push",
      "category": "crm",
      "blurb": "Sends sign-ups and conversions to your affiliate program.",
      "connect_method": "api_key",
      "event_types": [
        "Event type"
      ],
      "credentials": [
        {
          "key": "apiKey",
          "label": "Brightwater Analytics",
          "hint": "Create it in your affiliate dashboard.",
          "secret": false
        }
      ],
      "fields": [
        {
          "key": "seats",
          "label": "Region",
          "placeholder": "Placeholder",
          "help": "Help"
        }
      ],
      "status": "active"
    }
  ]
}
```

</template>
</api-operation>


## Sitemap

See the full [sitemap](https://twominutebilling.com/sitemap.md) for all pages.