Account configuration, users, identities, and dropdown metadata
Get Account Configuration
Returns the API key's account in item: id, name, and timeZone, plus the sections selected with include. Without include, every section is returned.
query Parameters
includestringComma-separated sections to include:
stages,pipelines,users(active users),offices,sources,labels(the account's labels, sorted),identities(active identities). Unknown names are ignored. Omit to include all sections.Example: identities,users
Responses
OK
successboolean · requireditemobject · requiredAccount configuration.
id,name, andtimeZoneare always present; the other sections are included when requested withinclude(all sections by default).Example: {"id":"6b3e1a9d4c7f42e8a5d0c1f9b2e7a4c6","name":"Northwind Recruiting","timeZone":"America/New_York","pipelines":[{"id":"3d9a1c7e4b2f46d8a5c0e1f9b7d2a348","name":"Sales Hiring","displayName":"Sales Hiring","default":true}],"stages":[{"id":"9a3d7c1e4b2f48d6a5c0e1f9b7d2a346","name":"New Lead","pipelineId":"3d9a1c7e4b2f46d8a5c0e1f9b7d2a348","default":true,"order":0}],"offices":[{"id":"7c1e4a9d2b3f46d8a5c0e1f9b7d2a350","name":"New York","state":"NY","latitude":40.7505,"longitude":-73.9965}],"sources":[{"id":"2e9a7c1d4b3f46d8a5c0e1f9b2d7a351","name":"Referral"}],"users":[{"id":"b2e7a1d94c3f4a8eb6d05c1f9a7e2d45","displayName":"Jamie Lee","email":"jamie.lee@example.com","firstName":"Jamie","lastName":"Lee","role":"admin","phone":"15559876543"}],"identities":[{"id":"7e1c4a9d2b5f43e8a6d0c3f9b1e7a2d5","name":"Northwind Recruiting Team","email":"recruiting@northwind.example.com","phone":"15552220000","active":true,"description":"Main recruiting line","userIds":["b2e7a1d94c3f4a8eb6d05c1f9a7e2d45"]}]}
Get Account Configuration (Zapier Format)
The same account data as GET /account, returned as a one-element array (the format Zapier expects) instead of the { success, item } envelope. Sections: stages, pipelines, users (active users), offices, sources, and identities (active identities), selected with include; omit include for all of them. labels is not available here; use GET /account/labels.
query Parameters
includestringComma-separated sections:
stages,pipelines,users,offices,sources,identities. Omit to include all sections.Example: stages,users
Responses
OK
idstringnamestringtimeZonestring | nullstagesobject[]pipelinesobject[]usersobject[]officesobject[]sourcesobject[]identitiesobject[]
List Account Stages (for dynamic dropdowns)
Lists the account's stages as { id, name }, where name is <pipeline name> - <stage name>. Use id as stageId. The list is not paginated (pagination is empty).
query Parameters
pipelineIdstringOnly return stages in this pipeline.
Example: 3d9a1c7e4b2f46d8a5c0e1f9b7d2a348
Responses
OK
successboolean · requireditemsobject[] · requiredpaginationobject · requiredPagination metadata. Fields are included only when that resource supports them; some list endpoints return an empty object.
Example: {"nextPageToken":"opaque-page-token-example","hasMore":true,"totalCount":125}
List Account Pipelines (for dynamic dropdowns)
Lists the account's pipelines. Use id as pipelineId. The list is not paginated (pagination is empty).
Responses
OK
successboolean · requireditemsobject[] · requiredpaginationobject · requiredPagination metadata. Fields are included only when that resource supports them; some list endpoints return an empty object.
Example: {"nextPageToken":"opaque-page-token-example","hasMore":true,"totalCount":125}
List Account Sources (for dynamic dropdowns)
Lists the account's prospect sources. Use id as sourceId. The list is not paginated (pagination is empty).
Responses
OK
successboolean · requireditemsobject[] · requiredpaginationobject · requiredPagination metadata. Fields are included only when that resource supports them; some list endpoints return an empty object.
Example: {"nextPageToken":"opaque-page-token-example","hasMore":true,"totalCount":125}
List Account Offices (for dynamic dropdowns)
Lists the account's active offices. Use id as officeId. The list is not paginated (pagination is empty).
Responses
OK
successboolean · requireditemsobject[] · requiredpaginationobject · requiredPagination metadata. Fields are included only when that resource supports them; some list endpoints return an empty object.
Example: {"nextPageToken":"opaque-page-token-example","hasMore":true,"totalCount":125}
List Account Users (for dynamic dropdowns)
Lists the users on the account as { id, name }, where name is the user's full name (or email when no name is set). Use id for ownerId, userId, assignedTo, and similar fields. Users who were removed from the account are not listed, and they cannot be made owners, assignees, or meeting attendees. GET /account?include=users returns active users with their role. The list is not paginated (pagination is empty).
Responses
OK
successboolean · requireditemsobject[] · requiredpaginationobject · requiredPagination metadata. Fields are included only when that resource supports them; some list endpoints return an empty object.
Example: {"nextPageToken":"opaque-page-token-example","hasMore":true,"totalCount":125}
List Account Labels (for dynamic dropdowns)
Lists the account's labels as { id, name }, where both are the label text, sorted alphabetically (ignoring case). Use these values in a prospect's labels, removeLabels, or the label filter. The list is not paginated (pagination is empty).
Responses
OK
successboolean · requireditemsobject[] · requiredpaginationobject · requiredPagination metadata. Fields are included only when that resource supports them; some list endpoints return an empty object.
Example: {"nextPageToken":"opaque-page-token-example","hasMore":true,"totalCount":125}