> ## Documentation Index > Fetch the complete documentation index at: https://openphone-dev.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. # List phone numbers > Retrieve a paginated list of the phone numbers in your Quo workspace. Assigned users and usage restrictions are opt-in through the `include` parameter. ## OpenAPI ````yaml https://openphone-public-api-dev.s3.us-west-2.amazonaws.com/public/openphone-public-api-2026-03-30-dev.json get /phone-numbers openapi: 3.1.0 info: title: Quo Public API version: 1.0.0 description: API for connecting with Quo. contact: name: Quo Support email: support@quo.com url: https://support.quo.com/ termsOfService: https://www.quo.com/terms servers: - description: Development server url: https://dev-public-api.openphone.dev security: - apiKey: [] tags: - description: Operations related to calls name: Calls - description: >- Operations related to call summaries, including AI-generated summaries and Sona voice assistant summaries name: Call Summaries - description: >- Operations related to call transcripts, including AI-generated transcripts and Sona voice assistant transcripts name: Call Transcripts - description: Operations related to contacts name: Contacts - description: Operations related to contact shares name: Contact Shares - description: Operations related to contact notes name: Contact Notes - description: Operations related to contact properties name: Contact Properties - description: Operations related to conversations name: Conversations - description: Operations related to workspace invitations name: Invites - description: Operations related to text messages name: Messages - description: Operations related to the organization name: Organization - description: Operations related to phone numbers name: Phone Numbers - description: Operations related to users name: Users - description: Operations related to webhooks name: Webhooks - description: >- Operations related to webhook events, including delivery history and test events name: Webhook Events paths: /phone-numbers: get: tags: - Phone Numbers summary: List phone numbers description: >- Retrieve a paginated list of the phone numbers in your Quo workspace. Assigned users and usage restrictions are opt-in through the `include` parameter. operationId: listPhoneNumbers parameters: - in: query name: limit required: false schema: description: Max number of items to return per page. default: 10 maximum: 50 minimum: 1 type: integer - in: query name: after required: false schema: examples: - eyJsYXN0SWQiOiJVU211a09NaXBhIn0 type: string example: eyJsYXN0SWQiOiJVU211a09NaXBhIn0 - in: query name: userId required: false schema: description: Filter results to phone numbers assigned to the specified user. examples: - US123abc pattern: ^US(.*)$ type: string example: US123abc - in: query name: phoneNumber required: false schema: description: Filter results to the phone number matching this E.164 value. examples: - '+15555555555' pattern: ^\+[1-9]\d{1,14}$ type: string example: '+15555555555' - in: query name: include required: false schema: description: >- Comma-separated list of optional payload sections to include. `users` adds the members assigned to the number, `restrictions` adds its calling and messaging restrictions. Omitted sections are left out of the response entirely. examples: - users - users,restrictions maxItems: 2 uniqueItems: true type: array items: type: string enum: - users - restrictions example: users - in: header name: Quo-Api-Version required: true schema: type: string enum: - '2026-03-30' description: 'API version header. Supported values: 2026-03-30' responses: '200': description: OK content: application/json: schema: type: object required: - data - nextCursor properties: data: type: array items: type: object required: - id - groupId - name - number - formattedNumber - forward - portRequestId - portingStatus - symbol - createdAt - updatedAt properties: id: description: The unique identifier of the Quo phone number. examples: - PNlja6rrtI pattern: ^PN(.*)$ type: string example: PNlja6rrtI groupId: description: >- The unique identifier of the group to which the Quo number belongs. examples: - GRcei8k90o pattern: ^GR(.*)$ type: string example: GRcei8k90o name: description: The display name of the phone number. examples: - My phone number type: string example: My phone number number: description: >- A phone number in E.164 format, including the country code. examples: - '+15555555555' pattern: ^\+[1-9]\d{1,14}$ type: string example: '+15555555555' formattedNumber: anyOf: - description: >- A human-readable representation of the phone number. examples: - (555) 555-5555 type: string example: (555) 555-5555 - type: 'null' forward: anyOf: - description: >- Forwarding number for incoming calls, null if no forwarding number is configured. examples: - '+15555555555' type: string example: '+15555555555' - type: 'null' portRequestId: anyOf: - description: >- Unique identifier for the phone number’s porting request, if applicable. examples: - 123abc type: string example: 123abc - type: 'null' portingStatus: anyOf: - description: >- Current status of the porting process, if applicable. examples: - completed type: string example: completed - type: 'null' symbol: anyOf: - description: >- Custom symbol or emoji associated with the phone number. examples: - 🏡 type: string example: 🏡 - type: 'null' createdAt: description: >- Timestamp of when the phone number was added to the workspace, in ISO 8601 format. examples: - '2022-01-01T00:00:00Z' format: date-time type: string example: '2022-01-01T00:00:00Z' updatedAt: description: >- Timestamp of the last update to the phone number’s details, in ISO 8601 format. examples: - '2022-01-01T00:00:00Z' format: date-time type: string example: '2022-01-01T00:00:00Z' users: description: >- The members assigned to this phone number. Only present when `include` contains `users`. type: array items: type: object required: - id - email - firstName - lastName - role - groupId properties: id: description: The unique identifier of the user. examples: - US123abc pattern: ^US(.*)$ type: string example: US123abc email: description: The user's email address. examples: - johndoe@example.com format: email type: string example: johndoe@example.com firstName: anyOf: - description: The user's first name. examples: - John type: string example: John - type: 'null' lastName: anyOf: - description: The user's last name. examples: - Doe type: string example: Doe - type: 'null' role: type: string enum: - owner - admin - member description: The user's role in the organization. examples: - owner - admin - member example: owner groupId: description: >- The unique identifier of the group to which the user belongs. examples: - GRcei8k90o pattern: ^GR(.*)$ type: string example: GRcei8k90o restrictions: type: object required: - calling - messaging properties: calling: type: object required: - CA - Intl - US properties: CA: type: string enum: - restricted - unrestricted description: >- The phone-number usage restriction status for a specific region. examples: - unrestricted example: unrestricted Intl: type: string enum: - restricted - unrestricted description: >- The phone-number usage restriction status for a specific region. examples: - unrestricted example: unrestricted US: type: string enum: - restricted - unrestricted description: >- The phone-number usage restriction status for a specific region. examples: - unrestricted example: unrestricted messaging: type: object required: - CA - Intl - US properties: CA: type: string enum: - restricted - unrestricted description: >- The phone-number usage restriction status for a specific region. examples: - unrestricted example: unrestricted Intl: type: string enum: - restricted - unrestricted description: >- The phone-number usage restriction status for a specific region. examples: - unrestricted example: unrestricted US: type: string enum: - restricted - unrestricted description: >- The phone-number usage restriction status for a specific region. examples: - unrestricted example: unrestricted nextCursor: description: >- Cursor for the next page, or null when there are no more pages. examples: - eyJsYXN0SWQiOiJVU211a09NaXBhIn0 example: eyJsYXN0SWQiOiJVU211a09NaXBhIn0 anyOf: - type: string - type: 'null' '400': description: Bad Request content: application/json: schema: type: object required: - message - docs - title properties: message: type: string docs: const: https://quo.com/docs type: string title: const: Bad Request type: string trace: type: string errors: type: array items: type: object required: - path - message - schema properties: path: type: string message: type: string value: {} schema: type: object required: - type properties: type: type: string example: message: The input was invalid docs: https://quo.com/docs title: Bad Request errors: - path: /include message: 'Value must be one of: users, restrictions' value: settings schema: type: array '401': description: Unauthorized content: application/json: schema: type: object required: - message - docs - title properties: message: type: string docs: const: https://quo.com/docs type: string title: const: Unauthorized type: string trace: type: string errors: type: array items: type: object required: - path - message - schema properties: path: type: string message: type: string value: {} schema: type: object required: - type properties: type: type: string example: message: Unauthorized docs: https://quo.com/docs title: Unauthorized trace: '6897907457496870895' '403': description: Forbidden content: application/json: schema: type: object required: - message - docs - title properties: message: type: string docs: const: https://quo.com/docs type: string title: const: Forbidden type: string trace: type: string errors: type: array items: type: object required: - path - message - schema properties: path: type: string message: type: string value: {} schema: type: object required: - type properties: type: type: string example: message: User is forbidden to perform this action docs: https://quo.com/docs title: Forbidden trace: '6897907457496870895' '500': description: Unknown Error content: application/json: schema: type: object required: - message - docs - title properties: message: type: string docs: const: https://quo.com/docs type: string title: const: Unknown type: string trace: type: string errors: type: array items: type: object required: - path - message - schema properties: path: type: string message: type: string value: {} schema: type: object required: - type properties: type: type: string example: message: We have encountered an unknown error docs: https://quo.com/docs title: Unknown trace: '6897907457496870895' security: - apiKey: [] components: securitySchemes: apiKey: in: header name: Authorization type: apiKey ````