SAsalesforge
Contacts

Get contacts

Get contacts associated with the workspace. Supported filters: tag_ids[] (aliases: tagIds), validation_statuses[] (aliases: validationStatus, validationStatuses; valid is accepted as safe), not_in_sequence_id (alias: notInSequenceId). Unknown query parameters return 400. Set pagination=cursor for the first cursor page; pass nextCursor as cursor with the same workspace and filters for subsequent pages. Cursor responses contain data, limit, hasMore and nextCursor (omitted on the last page), without total or offset. Omitting pagination and cursor preserves offset pagination.

get/workspaces/{workspaceID}/contacts

Request

  • Base URL
    https://api.salesforge.ai/public/v2
  • Auth
    API key in header Authorization

Path parameters

workspaceIDstring required

Workspace ID

Query parameters

limitinteger

Limit

offsetinteger

Offset (cannot be nonzero with cursor pagination)

pagination'offset' | 'cursor'

Pagination mode

cursorstring

Opaque nextCursor from the preceding response; implies cursor pagination

tag_ids[]string[]

Filter by tag ids

tagIdsstring[]

Alias for tag_ids[]

not_in_sequence_idstring

Filter by contacts not in sequence

notInSequenceIdstring

Alias for not_in_sequence_id

validation_statuses[]string[]

Filter by validation statuses

validationStatusstring[]

Alias for validation_statuses[]

Response

Contact list in offset or cursor mode; nextCursor is omitted on the last cursor page

OR

Changes

No recorded changes to this operation across all 1 revision of this API.