List all Number Group Memberships

GET 
/number_groups/:NumberGroupId/number_group_memberships

Returns a list of a Number Group's Memberships. The memberships are returned sorted by creation date, with the most recent appearing first.

Permissions

The API token must include the following scopes: Numbers.

Request

Path Parameters

NumberGroupId uuidrequired

Unique ID of the number group

Responses

200

OK

application/json

Schema

Schema

links

object

self string

first string

next string

prev string

data

object[]

Array [

id uuid

The unique identifier of the Number Group Membership on SignalWire. This can be used to delete the membership programmatically.

number_group_id uuid

The unique identifier of the Number Group this membership is associated with.

phone_number

object

A representation of the phone number this membership is associated with.

id uuid

name string

number string

capabilities string[]

]

Example (from schema)

{
  "links": {
    "self": "string",
    "first": "string",
    "next": "string",
    "prev": "string"
  },
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "number_group_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "phone_number": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "name": "Jenny",
        "number": "+15558675309",
        "capabilities": [
          "voice",
          "sms",
          "mms",
          "fax"
        ]
      }
    }
  ]
}

Loading...