CLclose
phone_numbers

List or search for phone numbers

Changed on
get/phone_number/

Request

  • Base URL
    https://api.close.com/api/v1
  • URL
    https://api.close.com/api/v1/phone_number/
  • Auth
    • HTTP basic
    • or OAuth 2
      Authorization code: https://app.close.com/oauth2/authorize/
      Token URL: https://api.close.com/oauth2/token/

Query parameters

_limitinteger

Number of results to return.

_skipinteger

Number of results to skip before returning, for pagination.

_fieldsstring

Comma-separated list of fields to include in the response.

numberstring nullable
user_idstring nullable

Deprecated. Use participant_user_id instead. The distinction between personal and group numbers is being removed, and user_id will be removed in a future update.

is_group_numberboolean nullable

Deprecated. Use participant_user_id instead. The distinction between personal and group numbers is being removed, and is_group_number will be removed in a future update.

participant_user_idstring nullable

Return numbers the given user is a member of, directly or through an assigned Group.

Response

Successful response

has_moreboolean required

Changes

  • 7bdb9cfcca22Revision changes
    • breaking

      for the query request parameter _limit, default value was changed from 100 to 1000

    • warning

      for the query request parameter _limit, the max was set to 1000.00

    • warning

      for the query request parameter _skip, the max was set to 10000.00

  • 2ff98656cc2aRevision changes
    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      removed the non-success response with the status