Accounts

Get a list of accounts

get

Returns a paginated list of accounts for the organization.

Rate limit: 60 requests per minute

Authorizations

bearerAuth

AuthorizationstringRequired

Authorization: Bearer

Query parameters

cursorstringOptional

The cursor to use for pagination.

limitinteger · int64Required

The number of accounts to fetch. Defaults to 100. Must be greater than 0 and less than 1000.

Responses

200Success

application/json

400Error

application/json

404Error

application/json

500Error

application/json

get

/accounts

HTTPcURLJavaScriptPython

GET /accounts?limit=1 HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "channels": [
        {
          "channel_id": "text",
          "is_internal": true,
          "is_primary": true,
          "mirror_to": {
            "channel_id": "text",
            "source": "text"
          },
          "source": "text"
        }
      ],
      "created_at": "text",
      "crm_settings": {
        "details": [
          {
            "id": "text",
            "source": "text"
          }
        ]
      },
      "custom_fields": {
        "ANY_ADDITIONAL_PROPERTY": {
          "slug": "text",
          "value": "text",
          "values": [
            "text"
          ]
        }
      },
      "domain": "text",
      "domains": [
        "text"
      ],
      "external_ids": [
        {
          "external_id": "text",
          "label": "text"
        }
      ],
      "id": "text",
      "is_disabled": true,
      "latest_customer_activity_time": "text",
      "name": "text",
      "owner": {
        "email": "text",
        "id": "text"
      },
      "primary_domain": "text",
      "tags": [
        "text"
      ],
      "type": "text"
    }
  ],
  "pagination": {
    "cursor": "text",
    "has_next_page": true
  },
  "request_id": "text"
}

Create a new account

post

Creates a new account with the specified name and optional metadata.

Rate limit: 60 requests per minute

Authorizations

bearerAuth

AuthorizationstringRequired

Authorization: Bearer

Body

application/json

domainstringOptional

Deprecated. Please use Domains and PrimaryDomain instead.

domainsstring[]Optional

The domains of the account, without any leading scheme, for example stripe.com. Must specify one domain as primary.

logo_urlstringOptional

The logo URL of the account. Must be a square .png, .jpg or .jpeg.

namestringRequired

The name of the account.

owner_idstringOptional

The ID of the owner of the account.

primary_domainstringOptional

Must be in the list of domains. If there are any domains, there must be exactly one primary domain.

subaccount_idsstring[]Optional

An array of account IDs to be added as subaccounts to this account.

tagsstring[]Optional

An array of strings to use as tags on this account. If provided, the accounts tags will be updated to the given tags.

Responses

200Success

application/json

400Error

application/json

404Error

application/json

500Error

application/json

post

/accounts

HTTPcURLJavaScriptPython

POST /accounts HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 412

{
  "channels": [
    {
      "channel_id": "text",
      "is_internal": true,
      "is_primary": true,
      "mirror_to": {
        "channel_id": "text",
        "source": "text"
      },
      "source": "text"
    }
  ],
  "custom_fields": [
    {
      "slug": "text",
      "value": "text",
      "values": [
        "text"
      ]
    }
  ],
  "domain": "text",
  "domains": [
    "text"
  ],
  "external_ids": [
    {
      "external_id": "text",
      "label": "text"
    }
  ],
  "logo_url": "text",
  "name": "text",
  "owner_id": "text",
  "primary_domain": "text",
  "subaccount_ids": [
    "text"
  ],
  "tags": [
    "text"
  ]
}

{
  "data": {
    "channels": [
      {
        "channel_id": "text",
        "is_internal": true,
        "is_primary": true,
        "mirror_to": {
          "channel_id": "text",
          "source": "text"
        },
        "source": "text"
      }
    ],
    "created_at": "text",
    "crm_settings": {
      "details": [
        {
          "id": "text",
          "source": "text"
        }
      ]
    },
    "custom_fields": {
      "ANY_ADDITIONAL_PROPERTY": {
        "slug": "text",
        "value": "text",
        "values": [
          "text"
        ]
      }
    },
    "domain": "text",
    "domains": [
      "text"
    ],
    "external_ids": [
      {
        "external_id": "text",
        "label": "text"
      }
    ],
    "id": "text",
    "is_disabled": true,
    "latest_customer_activity_time": "text",
    "name": "text",
    "owner": {
      "email": "text",
      "id": "text"
    },
    "primary_domain": "text",
    "tags": [
      "text"
    ],
    "type": "text"
  },
  "request_id": "text"
}

Update multiple accounts

patch

Updates multiple accounts in a single request. Only provided fields are modified.

Rate limit: 20 requests per minute

Authorizations

bearerAuth

AuthorizationstringRequired

Authorization: Bearer

Body

application/json

account_idsstring[]Required

The account IDs to update. The number of accounts to update must be between 1 and 100.

owner_idstringOptional

The ID of the new owner. If empty string is passed in, the owner will be removed.

tagsstring[]Optional

An array of tags to be updated on the accounts.

tags_apply_modestringOptional

The mode for applying tags. Valid values: "append_only", "remove_only", "replace". Defaults to "replace".

Responses

200Success

application/json

400Error

application/json

500Error

application/json

patch

/accounts

HTTPcURLJavaScriptPython

PATCH /accounts HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 150

{
  "account_ids": [
    "text"
  ],
  "custom_fields": [
    {
      "slug": "text",
      "value": "text",
      "values": [
        "text"
      ]
    }
  ],
  "owner_id": "text",
  "tags": [
    "text"
  ],
  "tags_apply_mode": "text"
}

{
  "request_id": "text",
  "success": true
}

Get an account by its ID or external ID

get

Returns a single account by ID or external ID.

Rate limit: 60 requests per minute

Authorizations

bearerAuth

AuthorizationstringRequired

Authorization: Bearer

Path parameters

idstringRequired

The ID or external ID of the account to fetch.

Responses

200Success

application/json

400Error

application/json

404Error

application/json

500Error

application/json

get

/accounts/{id}

HTTPcURLJavaScriptPython

GET /accounts/{id} HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": {
    "channels": [
      {
        "channel_id": "text",
        "is_internal": true,
        "is_primary": true,
        "mirror_to": {
          "channel_id": "text",
          "source": "text"
        },
        "source": "text"
      }
    ],
    "created_at": "text",
    "crm_settings": {
      "details": [
        {
          "id": "text",
          "source": "text"
        }
      ]
    },
    "custom_fields": {
      "ANY_ADDITIONAL_PROPERTY": {
        "slug": "text",
        "value": "text",
        "values": [
          "text"
        ]
      }
    },
    "domain": "text",
    "domains": [
      "text"
    ],
    "external_ids": [
      {
        "external_id": "text",
        "label": "text"
      }
    ],
    "id": "text",
    "is_disabled": true,
    "latest_customer_activity_time": "text",
    "name": "text",
    "owner": {
      "email": "text",
      "id": "text"
    },
    "primary_domain": "text",
    "tags": [
      "text"
    ],
    "type": "text"
  },
  "request_id": "text"
}

Update an existing account

patch

Updates an existing account by ID or external ID. Only provided fields are modified.

Rate limit: 60 requests per minute

Authorizations

bearerAuth

AuthorizationstringRequired

Authorization: Bearer

Path parameters

idstringRequired

The ID or external ID of the account to update.

Body

application/json

domainsstring[]Optional

Domains of the account. Must specify one domain as primary.

is_disabledbooleanOptional

Whether the account is disabled.

logo_urlstringOptional

Logo URL of the account.

namestringOptional

The name of the account.

owner_idstringOptional

The ID of the owner of the account. If empty string is passed in, the owner will be removed.

primary_domainstringOptional

Must be in the list of domains. If there are any domains, there must be exactly one primary domain.

subaccount_idsstring[]Optional

An array of account IDs to be added as subaccounts to this account.

tagsstring[]Optional

An array of strings to use as tags on this account. If provided, the accounts tags will be updated to the given tags.

Responses

200Success

application/json

400Error

application/json

404Error

application/json

500Error

application/json

patch

/accounts/{id}

HTTPcURLJavaScriptPython

PATCH /accounts/{id} HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 415

{
  "channels": [
    {
      "channel_id": "text",
      "is_internal": true,
      "is_primary": true,
      "mirror_to": {
        "channel_id": "text",
        "source": "text"
      },
      "source": "text"
    }
  ],
  "custom_fields": [
    {
      "slug": "text",
      "value": "text",
      "values": [
        "text"
      ]
    }
  ],
  "domains": [
    "text"
  ],
  "external_ids": [
    {
      "external_id": "text",
      "label": "text"
    }
  ],
  "is_disabled": true,
  "logo_url": "text",
  "name": "text",
  "owner_id": "text",
  "primary_domain": "text",
  "subaccount_ids": [
    "text"
  ],
  "tags": [
    "text"
  ]
}

{
  "data": {
    "channels": [
      {
        "channel_id": "text",
        "is_internal": true,
        "is_primary": true,
        "mirror_to": {
          "channel_id": "text",
          "source": "text"
        },
        "source": "text"
      }
    ],
    "created_at": "text",
    "crm_settings": {
      "details": [
        {
          "id": "text",
          "source": "text"
        }
      ]
    },
    "custom_fields": {
      "ANY_ADDITIONAL_PROPERTY": {
        "slug": "text",
        "value": "text",
        "values": [
          "text"
        ]
      }
    },
    "domain": "text",
    "domains": [
      "text"
    ],
    "external_ids": [
      {
        "external_id": "text",
        "label": "text"
      }
    ],
    "id": "text",
    "is_disabled": true,
    "latest_customer_activity_time": "text",
    "name": "text",
    "owner": {
      "email": "text",
      "id": "text"
    },
    "primary_domain": "text",
    "tags": [
      "text"
    ],
    "type": "text"
  },
  "request_id": "text"
}

Delete an existing account

delete

Permanently deletes an account by ID or external ID.

Rate limit: 10 requests per minute

Authorizations

bearerAuth

AuthorizationstringRequired

Authorization: Bearer

Path parameters

idstringRequired

The ID or external ID of the account to delete.

Responses

200Success

application/json

delete

/accounts/{id}

HTTPcURLJavaScriptPython

DELETE /accounts/{id} HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "request_id": "text"
}

Search for accounts by a given filter

post

Currently, the following fields are filterable for accounts:

• id. Allowed operators: equals, in, not_in

• domains. Allowed operators: contains, does_not_contain, in, not_in

• tags. Allowed operators: contains, does_not_contain, in, not_in

• name. Allowed operators: equals, in, not_in, string_contains

• external_ids. Allowed operators: equals, in, not_in, is_set, is_unset

• owner_id. Allowed operators: equals, in, not_in, is_set, is_unset

• custom fields (pass in the slug of the custom field)

Rate limit: 20 requests per minute

Authorizations

bearerAuth

AuthorizationstringRequired

Authorization: Bearer

Body

application/json

cursorstringOptional

The cursor to use for pagination.

limitinteger · int64Optional

The number of accounts to fetch. Defaults to 100. Must be greater than 0 and less than 1000.

Responses

200Success

application/json

400Error

application/json

404Error

application/json

500Error

application/json

post

/accounts/search

HTTPcURLJavaScriptPython

POST /accounts/search HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 312

{
  "cursor": "text",
  "filter": {
    "field": "text",
    "operator": "equals",
    "subfilters": [
      {
        "field": "text",
        "operator": "equals",
        "subfilters": [
          {
            "field": "text",
            "operator": "equals",
            "subfilters": "[Circular Reference]",
            "value": "text",
            "values": [
              "text"
            ]
          }
        ],
        "value": "text",
        "values": [
          "text"
        ]
      }
    ],
    "value": "text",
    "values": [
      "text"
    ]
  },
  "limit": 1
}

{
  "data": [
    {
      "channels": [
        {
          "channel_id": "text",
          "is_internal": true,
          "is_primary": true,
          "mirror_to": {
            "channel_id": "text",
            "source": "text"
          },
          "source": "text"
        }
      ],
      "created_at": "text",
      "crm_settings": {
        "details": [
          {
            "id": "text",
            "source": "text"
          }
        ]
      },
      "custom_fields": {
        "ANY_ADDITIONAL_PROPERTY": {
          "slug": "text",
          "value": "text",
          "values": [
            "text"
          ]
        }
      },
      "domain": "text",
      "domains": [
        "text"
      ],
      "external_ids": [
        {
          "external_id": "text",
          "label": "text"
        }
      ],
      "id": "text",
      "is_disabled": true,
      "latest_customer_activity_time": "text",
      "name": "text",
      "owner": {
        "email": "text",
        "id": "text"
      },
      "primary_domain": "text",
      "tags": [
        "text"
      ],
      "type": "text"
    }
  ],
  "pagination": {
    "cursor": "text",
    "has_next_page": true
  },
  "request_id": "text"
}