List or search for phone numbers | Close | Developer API Documentation

curl https://api.close.com/api/v1/phone_number/ \
     -u "<CLOSE_API_KEY>:"

{
  "data": [
    {
      "address_id": null,
      "bundle_id": null,
      "carrier": null,
      "carrier_type": null,
      "country": "US",
      "date_created": "2016-07-18T22:54:24.787000+00:00",
      "date_updated": "2016-07-18T22:55:55.938000+00:00",
      "id": "phon_asdjkfev50ZKOqTVndOFN4effzv99vDvpDxrks9XLU3",
      "is_group_number": false,
      "is_premium": false,
      "is_verified": true,
      "label": "Primary Number",
      "last_billed_price": null,
      "mms_enabled": true,
      "next_billing_on": null,
      "number": "+16503335555",
      "number_formatted": "+1 650-333-5555",
      "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
      "sms_enabled": true,
      "supports_mms_to_countries": [
        "CA",
        "US"
      ],
      "supports_sms_to_countries": [
        "CA",
        "US"
      ],
      "type": "internal",
      "user_id": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
      "forward_to": null,
      "forward_to_enabled": false,
      "forward_to_formatted": null,
      "participants": [],
      "phone_numbers": [
        "+16508889898"
      ],
      "phone_numbers_formatted": [
        "+1 650-888-9898"
      ],
      "press_1_to_accept": false,
      "voicemail_greeting_url": null,
      "was_ported": false
    },
    {
      "address_id": null,
      "bundle_id": null,
      "carrier": null,
      "carrier_type": null,
      "country": "US",
      "date_created": "2016-07-18T22:54:24.787000+00:00",
      "date_updated": "2016-07-18T22:55:55.938000+00:00",
      "id": "phon_973589ev50ZKOqTVndOFN4effz092753608234569U3",
      "is_group_number": false,
      "is_premium": false,
      "is_verified": true,
      "label": "My Personal Cell",
      "last_billed_price": null,
      "mms_enabled": true,
      "next_billing_on": null,
      "number": "+14151231234",
      "number_formatted": "+1 415-123-1234",
      "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
      "sms_enabled": false,
      "supports_mms_to_countries": [
        "CA",
        "US"
      ],
      "supports_sms_to_countries": [],
      "type": "external",
      "user_id": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
      "forward_to": null,
      "forward_to_enabled": false,
      "forward_to_formatted": null,
      "participants": [],
      "phone_numbers": [],
      "phone_numbers_formatted": [],
      "press_1_to_accept": false,
      "voicemail_greeting_url": null,
      "was_ported": false
    },
    {
      "address_id": null,
      "bundle_id": null,
      "carrier": null,
      "carrier_type": null,
      "country": "US",
      "date_created": "2016-07-14T20:37:23.022000+00:00",
      "date_updated": "2016-07-18T22:54:41.548000+00:00",
      "id": "phon_324230958beOjoa6F42w5Hlkdjfg8p3wmIPnTuvNbaX",
      "is_group_number": true,
      "is_premium": false,
      "is_verified": true,
      "label": "Group Number",
      "last_billed_price": null,
      "mms_enabled": true,
      "next_billing_on": null,
      "number": "+16508881234",
      "number_formatted": "+1 650-888-1234",
      "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
      "sms_enabled": true,
      "supports_mms_to_countries": [
        "CA",
        "US"
      ],
      "supports_sms_to_countries": [
        "CA",
        "US"
      ],
      "type": "internal",
      "user_id": null,
      "forward_to": null,
      "forward_to_enabled": false,
      "forward_to_formatted": null,
      "participants": [
        "user_OWiN4rEbBR04K2AKXe3jq5j1JWQqmTguuuZa1dG7qQr",
        "user_Ova4RGFG7pztSeJiiMFdN7O2MFl71nD0uGO3bIOo4Wk",
        "user_SJMF1fEyZGdtl2RPzCm9zVQ7qhd33VajdGDREhbsxjF"
      ],
      "phone_numbers": [],
      "phone_numbers_formatted": [],
      "press_1_to_accept": false,
      "voicemail_greeting_url": null
    }
  ],
  "has_more": false
}

Authentication

AuthorizationBasic

Use your API key as the username and leave the password empty.

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

_limitintegerOptionalDefaults to 100

Number of results to return.

_skipintegerOptionalDefaults to 0

Number of results to skip before returning, for pagination.

_fieldsstringOptional

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

numberstring or nullOptional

user_idstring or nullOptional

is_group_numberboolean or nullOptional

Response

Successful response

datalist of objects

has_moreboolean

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error