Retrieve a customer

GET /v1/customers/{id}

Send your API key as a bearer token: Authorization: Bearer ssms_sk_.... Test keys run this endpoint against the sandbox; see Authentication for key modes and scopes.

Path parameters

Name	Type	Required	Description
`id`	string	Yes

Responses

Status	Meaning	Body
200	The customer, with phone_numbers assigned to it	`Customer`
401	Missing, malformed, or revoked API key	`Error`
402	Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged	`Error`
404	Not found	`Error`
429	Rate limit or quota exceeded	`Error`

200: `Customer` fields

Field	Type	Description
`id`	string	Example: `cus_a1B2c3D4e5F6g7`.
`object`	`customer`
`name`	string	Nullable.
`external_id`	string	Nullable.
`metadata`	object
`created_at`	string (date-time)
`updated_at`	string (date-time)
`phone_numbers`	array of string	Only on retrieve

Errors

Status	When
401	Missing, malformed, or revoked API key
402	Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged
404	Not found
429	Rate limit or quota exceeded

Every error has the same JSON shape, and request_id matches the X-Request-Id response header. Errors lists every code and what to do about it.

json

{
  "error": {
    "code": "invalid_request",
    "message": "What went wrong, in plain words.",
    "param": "the_field",
    "request_id": "req_a1B2c3D4e5F6g7H8"
  }
}

Examples

curl

bash

curl -X GET "https://api.joinsimplesms.com/v1/customers/cus_a1B2c3D4e5F6g7" \
  -H "Authorization: Bearer $SIMPLESMS_API_KEY"

Node.js

javascript

import { SimpleSMS } from 'joinsimplesms'; // npm install joinsimplesms

const sms = new SimpleSMS(process.env.SIMPLESMS_API_KEY);

const customer = await sms.customers.get('cus_a1B2c3D4e5F6g7');

Python

python

import os
from joinsimplesms import SimpleSMS  # pip install joinsimplesms

client = SimpleSMS(os.environ["SIMPLESMS_API_KEY"])

customer = client.customers.get("cus_a1B2c3D4e5F6g7")