Accounts API

An account represents business or organization. Accounts can have multiple contacts under them and one primary contact. 

Account Fields Overview (JSON | XML schema)

  • name (required) - the name of this account
  • description - additional information about this account
  • owned_by - the ID of the Tripleseat user who owns this account (see users API)
  • primary_contact_id - Contact ID of the primary contact for this account
  • phone_numbers - Nested collection of phone numbers
  • websites - Nested collection of websites
  • addresses - Nested collection of addresses
  • custom_fields - Nested collection of Custom Fields

Account Show / List Endpoints (JSON | XML schema)

GET /v1/accounts.(xml | json) 

Retrieves a paginated list of accounts (50 per page, use page parameter to iterate over pages).

GET /v1/accounts/{id}.(xml | json) 

Retrieves an account by its ID.

DELETE /v1/accounts/{id}.(xml | json)

Deletes the account for the given ID. 

GET /v1/accounts/search.(xml | json)?{search params}

Search for accounts using filtering parameters (listed below). Append parameters together using & (e.g., ?query=kevin&sort_direction=desc&order=created_at).

Search Parameters and values

  • query - searches by name, contact, account, email, phone
  • order - created_at, updated_at, name
  • sort_direction - desc, asc
  • account_created_start_date - mm/dd/yyyy (also requires end date)
  • account_created_end_date - mm/dd/yyyy (also requires start date)
  • account_updated_start_date - mm/dd/yyyy (also requires end date)
  • account_updated_end_date - mm/dd/yyyy (also requires start date)
  • page (1..9999999)

Account Create/Update Endpoints (JSON | XML schema)

POST /v1/accounts.(xml | json)?account={account parameters}

Creates an account using the passed in account parameters. Parameters are expected to follow the format listed in the JSON/XML schema above.

PUT /v1/accounts/{id}.(xml | json)?account={account parameters}

Works just like the create method except you need to pass in the ID of the account to update.

Have more questions? Submit a request

Comments