List accounts

Lists your accounts a page at a time, with optional filters and sorting.

GET /accounts

cURL

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/accounts?limit=20&filter_status=ACTIVE" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

200

{
  "object": "<string>",
  "url": "<string>",
  "data": [
    {
      "object": "<string>",
      "id": "<string>",
      "name": "<string>",
      "status": "<string>",
      "type": "<string>",
      "display_name": "<string>",
      "email_address": "<string>",
      "description": "<string>",
      "currency": {
        "code": "<string>",
        "href": "<string>",
        "id": "<string>",
        "name": "<string>",
        "object": "<string>"
      },
      "time_zone": {
        "object": "<string>",
        "id": "<string>",
        "name": "<string>",
        "href": "<string>"
      },
      "tax": {
        "object": "<string>",
        "id": "<string>",
        "name": "<string>",
        "code": "<string>",
        "href": "<string>",
        "rate": 123
      },
      "custom_form": {
        "object": "<string>",
        "id": "<string>",
        "name": "<string>",
        "href": "<string>"
      },
      "parent_account_id": "<string>",
      "image_url": "<unknown>",
      "workflow_status": "<string>",
      "social_links": {
        "website": "<string>",
        "linkedin": "<string>",
        "twitter": "<string>",
        "facebook": "<string>"
      },
      "communication_preferences": [
        {
          "channel": "<string>",
          "enabled": true
        }
      ],
      "invoice_parent_account": true,
      "portal_access": true,
      "origin": "<string>",
      "group": {
        "object": "<string>",
        "id": "<string>",
        "name": "<string>",
        "code": "<string>",
        "href": "<string>",
        "rate": 123
      },
      "manager": {
        "object": "<string>",
        "id": "<string>",
        "name": "<string>",
        "code": "<string>",
        "href": "<string>",
        "rate": 123
      },
      "sales_rep": {
        "object": "<string>",
        "id": "<string>",
        "name": "<string>",
        "code": "<string>",
        "href": "<string>",
        "rate": 123
      },
      "user_team": {
        "object": "<string>",
        "id": "<string>",
        "name": "<string>",
        "code": "<string>",
        "href": "<string>",
        "rate": 123
      },
      "accounting_code": {
        "account_receivable": "<string>"
      },
      "pricing_level": {
        "object": "<string>",
        "id": "<string>",
        "name": "<string>",
        "code": "<string>",
        "href": "<string>",
        "rate": 123
      },
      "referral_tracking": "<string>",
      "created_on": "<string>",
      "last_updated_on": "<string>",
      "created_by": {
        "object": "<string>",
        "id": "<string>",
        "name": "<string>",
        "email": "<string>",
        "href": "<string>"
      },
      "last_updated_by": {
        "object": "<string>",
        "id": "<string>",
        "name": "<string>",
        "email": "<string>",
        "href": "<string>"
      },
      "version": 123,
      "href": "<string>",
      "addresses": [
        {
          "object": "<string>",
          "id": "<string>",
          "address_line_1": "<string>",
          "address_line_2": "<string>",
          "address_line_3": "<string>",
          "address_line_4": "<string>",
          "address_line_5": "<string>",
          "city": "<string>",
          "state": "<string>",
          "country": "<string>",
          "postal_code": "<string>",
          "default_billing": true,
          "default_shipping": true,
          "href": "<string>"
        }
      ],
      "contacts": [
        {
          "object": "<string>",
          "id": "<string>",
          "type": "<string>",
          "billing_contact": true,
          "shipping_contact": true,
          "receives_billing_information": true,
          "name": {
            "salutation": "<string>",
            "first": "<string>",
            "middle": "<string>",
            "last": "<string>",
            "designation": "<string>"
          },
          "email": {
            "address": "<string>",
            "do_not_email": true,
            "email_opted_out": true
          },
          "phone": {
            "country_code": "<string>",
            "area_code": "<string>",
            "number": "<string>",
            "do_not_call": true,
            "call_opted_out": true,
            "dialing_code": "<string>",
            "formatted": "<string>"
          },
          "mobile": {
            "country_code": "<string>",
            "area_code": "<string>",
            "number": "<string>",
            "do_not_call": true,
            "call_opted_out": true,
            "dialing_code": "<string>",
            "formatted": "<string>"
          },
          "fax": {
            "country_code": "<string>",
            "area_code": "<string>",
            "number": "<string>",
            "do_not_call": true,
            "call_opted_out": true,
            "dialing_code": "<string>",
            "formatted": "<string>"
          },
          "address": {
            "city": "<string>",
            "country": "<string>",
            "country_code": "<unknown>",
            "line_1": "<string>",
            "line_2": "<string>",
            "postal_code": "<string>",
            "state": "<string>"
          },
          "custom_attributes": [
            {
              "name": "<string>",
              "value": "<unknown>"
            }
          ],
          "created_on": "<string>",
          "last_updated_on": "<string>",
          "created_by": {
            "object": "<string>",
            "id": "<string>",
            "name": "<string>",
            "email": "<string>",
            "href": "<string>"
          },
          "last_updated_by": {
            "object": "<string>",
            "id": "<string>",
            "name": "<string>",
            "email": "<string>",
            "href": "<string>"
          },
          "version": 123
        }
      ],
      "payment_methods": [
        {
          "object": "<string>",
          "id": "<string>",
          "processor_type": "<string>",
          "status": "<string>",
          "default": true,
          "restricted_to_orders": true,
          "specified_order_ids": "<unknown>",
          "processor": {
            "object": "<string>",
            "id": "<string>",
            "name": "<string>",
            "href": "<string>"
          },
          "reference": "<string>",
          "payment_count": 123,
          "last_used_at": "<string>",
          "created_on": "<string>",
          "last_updated_on": "<string>",
          "created_by": {
            "object": "<string>",
            "id": "<string>",
            "name": "<string>",
            "email": "<string>",
            "href": "<string>"
          },
          "last_updated_by": {
            "object": "<string>",
            "id": "<string>",
            "name": "<string>",
            "email": "<string>",
            "href": "<string>"
          },
          "version": 123
        }
      ],
      "billing_preferences": {
        "communication_profile": "<string>",
        "invoice_mode": "<string>",
        "invoice_term": "<string>",
        "billing_period": "<string>",
        "billing_start_date": "<string>",
        "billing_start_day_of_month": 123,
        "charges_aligned_to_billing": true,
        "payment_processor": "<string>",
        "payment_mode": "<string>",
        "payment_term": "<string>",
        "payment_term_alignment": "<string>",
        "consolidate_invoice": true,
        "fulfillment_mode": "<string>",
        "fulfillment_term": "<string>",
        "proforma_properties": "<unknown>",
        "communication_group": "<string>",
        "billing_mode": "<string>",
        "charging_period": "<string>",
        "charging_and_billing_alignment": "<string>",
        "charging_start_date": "<string>",
        "event_profile": "<string>"
      },
      "custom_attributes": [
        {
          "href": "<string>",
          "id": "<string>",
          "name": "<string>",
          "object": "<string>",
          "type": "<string>",
          "value": "<unknown>"
        }
      ],
      "custom_objects": [
        {
          "object": "<string>",
          "id": "<string>",
          "name": "<string>",
          "code": "<string>",
          "href": "<string>",
          "rate": 123
        }
      ],
      "inventories": "<array>",
      "partial_invoices": "<array>",
      "activity_logs": "<array>",
      "payment_method": {
        "object": "<string>",
        "id": "<string>",
        "processor_type": "<string>",
        "status": "<string>",
        "default": true,
        "restricted_to_orders": true,
        "specified_order_ids": "<unknown>",
        "processor": {
          "object": "<string>",
          "id": "<string>",
          "name": "<string>",
          "href": "<string>"
        },
        "reference": "<string>",
        "payment_count": 123,
        "last_used_at": "<string>",
        "created_on": "<string>",
        "last_updated_on": "<string>",
        "created_by": {
          "object": "<string>",
          "id": "<string>",
          "name": "<string>",
          "email": "<string>",
          "href": "<string>"
        },
        "last_updated_by": {
          "object": "<string>",
          "id": "<string>",
          "name": "<string>",
          "email": "<string>",
          "href": "<string>"
        },
        "version": 123
      },
      "tax_id": "<unknown>",
      "tax_id_number": "<unknown>"
    }
  ],
  "pagination": {
    "limit": 123,
    "has_more": true,
    "next_cursor": "<string>",
    "prev_cursor": "<string>",
    "links": {
      "next": "<string>",
      "prev": "<string>"
    }
  }
}

Returns accounts under data, with pagination for the next page. Narrow the listing with filter_<field> for equality or filter_<field>_<operator> for other tests, such as filter_created_on_gte or filter_email_address_contains. Every filterable field also takes _neq; the text fields take _contains and _not_contains, and created_on and last_updated_on take _gt, _gte, _lt and _lte. The primary contact filters as filter_contact1_<field> and a custom attribute as filter_attribute_<name>.

The SDK samples get their client from credentials your app registers once when it starts, as shown in Authentication. To try the call here, click Try it, set host to your Exsited API host name and paste an access token from Get an access token.

Authorizations

Authorization · string · header · required

An access token from POST /api/v4/oauth2/token. The SDKs get and renew it for you.

Query Parameters

limit · integer

The most accounts to return on one page.

Example:

20

cursor · string

The pagination.next_cursor from the previous page, to fetch the next page.

sort · string

The field to sort by, such as created_on. Prefix it with - for descending order, as in -created_on.

filter_id · string

Only the account with this id.

filter_name · string

Only accounts with this name.

filter_display_name · string

Only accounts with this display_name.

filter_email_address · string

Only accounts with this email_address.

filter_description · string

Only accounts with this description.

filter_origin · string

Only accounts with this origin.

filter_website · string

Only accounts with this website.

filter_linkedin · string

Only accounts with this LinkedIn link.

filter_facebook · string

Only accounts with this Facebook link.

filter_twitter · string

Only accounts with this Twitter link.

filter_created_by · string

Only accounts created by this user.

filter_last_updated_by · string

Only accounts last changed by this user.

filter_status · string

Only accounts with this status, such as ACTIVE.

Example:

"ACTIVE"

filter_group · string

Only accounts in this account group.

filter_manager · string

Only accounts with this manager.

filter_currency · string

Only accounts in this currency.

filter_time_zone · string

Only accounts in this time zone.

filter_tax · string

Only accounts with this tax profile.

filter_uuid · string

Only the account with this uuid.

filter_communication_preference · string

Only accounts with this communication preference.

filter_accounting_code · string

Only accounts with this accounting code.

filter_created_on · string

Only accounts created on this date, as YYYY-MM-DD.

filter_last_updated_on · string

Only accounts last changed on this date, as YYYY-MM-DD.

Response

200

application/json

One page of accounts.

One page of accounts.

object · string

url · string

The path the listing came from, such as /api/v4/accounts.

data · object[]

Show child attributes

pagination · object

How to fetch the next page.

Show child attributes