> ## Documentation Index > Fetch the complete documentation index at: https://docs.blujay.io/llms.txt > Use this file to discover all available pages before exploring further. # List contacts > Returns the contacts in your workspace. ## OpenAPI ````yaml /api-reference/openapi.yaml get /v1/contacts openapi: 3.1.0 info: title: Blujay API version: 1.0.0 description: >- The Blujay API lets you send and receive iMessage, RCS and SMS messages from your Blujay phone numbers, manage contacts, and receive real-time webhooks. Every response uses the same JSON envelope and carries a `trace_id` you can share with support. Authenticate with your workspace API key. servers: - url: https://api.blujay.io description: Production security: - PublicApiKey: [] tags: - name: Auth description: Check which workspace and credential a request is using. - name: Chats description: >- Direct and group conversations between your Blujay numbers and your contacts. - name: Messages description: Send, read, edit, unsend and retry messages. - name: Phone Numbers description: >- Your Blujay numbers, whether each can send right now, and their live sending limits. - name: Capability description: >- Check whether a phone number can be reached by iMessage, RCS or SMS before you send. - name: Contacts description: Create, find, update, tag, assign and opt out contacts. - name: vCards description: >- Saved contact cards that you can send in a message. Recipients get a native contact card over iMessage, SMS or RCS. - name: Team Members description: People in your workspace you can assign contacts to. - name: Workflows description: Enroll contacts in workflows you start manually. - name: Attachments description: >- Upload files once and reuse them in messages, or download files from messages. - name: Webhooks description: Subscribe to events, inspect delivery attempts and verify signatures. paths: /v1/contacts: get: tags: - Contacts summary: List contacts description: Returns the contacts in your workspace. operationId: listPublicContacts parameters: - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Cursor' responses: '200': description: Your contacts. headers: X-Trace-ID: $ref: '#/components/headers/XTraceID' content: application/json: schema: allOf: - $ref: '#/components/schemas/SuccessEnvelope' - type: object required: - data properties: data: $ref: '#/components/schemas/PublicContactList' examples: contacts: summary: A page of contacts value: status: success data: data: - contact_id: contact_abc123 phone_number: '+15555550123' email: ava@example.com name: Ava Chen tags: - priority stage: Active assigned_team_member: id: member_abc123 name: Sam Rivera email: sam@example.com opted_out: false messaging_allowed: true created_at: '2026-10-14T16:58:30.000Z' updated_at: '2026-10-14T17:06:12.000Z' - contact_id: contact_def456 phone_number: '+15555550124' name: Jordan Lee tags: [] stage: Active assigned_team_member: null opted_out: true opted_out_at: '2026-10-14T09:15:00.000Z' opted_out_source: api messaging_allowed: false created_at: '2026-10-14T14:10:00.000Z' updated_at: '2026-10-14T09:15:00.000Z' has_more: false limit: 25 trace_id: trc_8f2a1c0e4b7d timestamp: '2026-10-14T17:10:00.000Z' security: - PublicApiKey: [] components: parameters: Limit: name: limit in: query description: Maximum number of items to return. schema: type: integer minimum: 1 maximum: 100 default: 25 Cursor: name: cursor in: query description: >- The `next_cursor` value from the previous page. Leave it out to get the first page. schema: type: string headers: XTraceID: description: >- Unique ID for this request. It matches `trace_id` in the body. Include it when you contact Blujay support. schema: $ref: '#/components/schemas/TraceId' schemas: SuccessEnvelope: type: object description: Wraps every successful response. The result is in `data`. required: - status - trace_id - timestamp properties: status: type: string enum: - success trace_id: $ref: '#/components/schemas/TraceId' timestamp: type: string examples: - '2026-10-14T17:01:00.000Z' format: date-time client_request_id: type: string description: >- Your `X-Request-ID` header value, echoed back when you send one. Not included on the send responses (`POST /v1/chats`, `POST /v1/chats/{chat_id}/messages`, `POST /v1/messages/{message_id}/retry`); keep your own mapping from your request ID to the returned message ID there. PublicContactList: type: object required: - data - has_more - limit properties: data: type: array items: $ref: '#/components/schemas/PublicContact' next_cursor: type: string examples: - AbC9xQ2nRk7vT1mZ has_more: type: boolean limit: type: integer examples: - 25 TraceId: type: string examples: - trc_8f2a1c0e4b7d pattern: ^trc_[A-Za-z0-9_-]+$ PublicContact: type: object additionalProperties: false required: - contact_id - tags - stage - assigned_team_member - opted_out - messaging_allowed - created_at - updated_at properties: contact_id: $ref: '#/components/schemas/ContactId' phone_number: type: string examples: - '+15555550123' email: type: string examples: - ava@example.com format: email name: type: string examples: - Ava Chen tags: type: array items: type: string examples: - priority stage: type: string examples: - Active assigned_team_member: oneOf: - $ref: '#/components/schemas/PublicAssignedTeamMember' - type: 'null' opted_out: type: boolean opted_out_at: type: string examples: - '2026-10-14T17:01:00.000Z' format: date-time opted_out_source: type: string examples: - api messaging_allowed: type: boolean created_at: type: string examples: - '2026-10-14T17:01:00.000Z' format: date-time updated_at: type: string examples: - '2026-10-14T17:01:00.000Z' format: date-time created: type: boolean description: Import responses only. True when the import created a new contact. updated: type: boolean description: >- Import responses only. True when the import updated an existing contact. tag_added: type: boolean description: Add-tag responses only. True when the tag was new to this contact. stage_changed: type: boolean description: Stage responses only. True when the stage changed. assignment_changed: type: boolean description: Assignee responses only. True when the assignee changed. ContactId: type: string examples: - contact_abc123 pattern: ^contact_[A-Za-z0-9_-]+$ PublicAssignedTeamMember: type: object additionalProperties: false required: - id - email properties: id: $ref: '#/components/schemas/MemberId' name: type: string examples: - Sam Rivera email: type: string examples: - sam@example.com format: email MemberId: type: string examples: - member_abc123 pattern: ^member_[A-Za-z0-9_-]+$ securitySchemes: PublicApiKey: type: http scheme: bearer bearerFormat: blu_... description: > Your workspace API key, sent as `Authorization: Bearer blu_...`. Workspace admins can find it in the Blujay app under **API**. An API key has full access to your workspace and works on every endpoint. There is no test mode: every key sends real messages and changes real data, so keep it secret and use it only from your server. Each API key can make 600 read requests and 120 write requests per minute, plus 60 attachment requests per minute. Over a limit you get `429 RATE_LIMIT_EXCEEDED` with `Retry-After`. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.