List business children - Marqeta Docs

GET///

To return an array of all child cardholders of a particular business, send a GET request to the /businesses/{parent_token}/children endpoint. Include the parent_token as a URL path parameter. This endpoint supports field filtering.

URL path parameters

Fields	Description
parent_token string Required	Unique identifier of the parent business. Allowable Values: Existing business resource token

URL query parameters

Fields	Description
count integer Optional	Number of child cardholders to retrieve. Allowable Values: 1-10
start_index integer Optional	Sort order index of the first resource in the returned array. Allowable Values: Any integer
fields string Optional	Comma-delimited list of fields to return (`field_1,field_2`, and so on). Leave blank to return all fields. Allowable Values: Comma-delimited list of fields, or blank
sort_by string Optional	Field on which to sort. Use any field in the resource model, or one of the system fields `lastModifiedTime` or `createdTime`. Prefix the field name with a hyphen (`-`) to sort in descending order. Omit the hyphen to sort in ascending order. Allowable Values: `createdTime`, `lastModifiedTime`, or any field in the resource model Default value: `-lastModifiedTime`

Response body

Fields	Description
count integer Conditionally returned	Number of user resources to retrieve. This field is returned if there are resources in your returned array. Allowable Values: 1-10
data array of objects Conditionally returned	Array of user objects. Objects are returned as appropriate to your query. Allowable Values: One or more user objects
data[].account_holder_group_token string Conditionally returned	Associates the specified account holder group with the cardholder. Allowable Values: 36 char max
data[].active boolean Conditionally returned	Specifies if the cardholder is in the `ACTIVE` state on the Marqeta platform. Allowable Values: `true`, `false`
data[].address1 string Conditionally returned	Cardholder’s address. Allowable Values: 255 char max
data[].address2 string Conditionally returned	Additional address information for the cardholder. Allowable Values: 255 char max
data[].authentication object Conditionally returned	Contains the cardholder’s email address and password information. Allowable Values: `email_verified`, `email_verified_time`, `last_password_update_channel`, `last_password_update_time`
data[].authentication.email_verified boolean Conditionally returned	Specifies whether the email address has been verified. Allowable Values: `true`, `false`
data[].authentication.email_verified_time datetime Conditionally returned	Date and time when the email address was verified. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ
data[].authentication.last_password_update_channel string Conditionally returned	Specifies the channel through which the password was last changed. Allowable Values: `USER_CHANGE`, `USER_RESET`
data[].authentication.last_password_update_time datetime Conditionally returned	Date and time when the password was last changed. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ
data[].birth_date string Conditionally returned	Cardholder’s date of birth. Allowable Values: Format: yyyy-MM-dd
data[].birth_place string Conditionally returned	Country where the cardholder was born. Allowable Values: 255 char max ISO 3166 two-character country codes. For example, the country code for the United States is `US`. The ISO maintains the full list of ISO-3166 country codes.
data[].business_token string Conditionally returned	Unique identifier of the business resource. Allowable Values: Existing business resource token
data[].city string Conditionally returned	City where the cardholder resides. Allowable Values: 40 char max
data[].company string Conditionally returned	Company name. Allowable Values: 255 char max
data[].corporate_card_holder boolean Conditionally returned	Specifies if the cardholder holds a corporate card. Allowable Values: `true`, `false`
data[].country string Conditionally returned	Country where the cardholder resides. Allowable Values: 40 char max
data[].created_time datetime Returned	Date and time when the resource was created, in UTC. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ
data[].email string Conditionally returned	Valid email address of the cardholder. Allowable Values: 1–255 chars
data[].first_name string Conditionally returned	Cardholder’s first name. Allowable Values: 40 char max
data[].gender string Conditionally returned	Gender of the cardholder. Allowable Values: `F`, `M`
data[].honorific string Conditionally returned	Cardholder’s title or prefix: Dr., Miss, Mr., Ms., and so on. Allowable Values: 10 char max
data[].id_card_expiration_date string Conditionally returned	Expiration date of the cardholder’s identification. Allowable Values: Format: yyyy-MM-dd
data[].id_card_number string Conditionally returned	Cardholder’s identification card number. Allowable Values: 255 char max
data[].identifications array of objects Conditionally returned	One or more objects containing identifications associated with the cardholder. Allowable Values: Valid array of one or more `identifications` objects
data[].identifications[].expiration_date string Conditionally returned	Expiration date of the identification, if applicable. Allowable Values: Format: yyyy-MM-dd
data[].identifications[].type string Conditionally returned	Type of identification. Allowable Values: `SSN`, `TIN`, `SIN`, `NIN`, `PASSPORT_NUMBER`, `DRIVERS_LICENSE`, `BUSINESS_NUMBER`, `BUSINESS_TAX_ID`, `TAXPAYER_REFERENCE`
data[].identifications[].value string Conditionally returned	Number associated with the identification. Allowable Values: 255 char max
data[].ip_address string Conditionally returned	Cardholder’s IP address. Allowable Values: 39 char max
data[].last_modified_time datetime Returned	Date and time when the resource was last updated, in UTC. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ
data[].last_name string Conditionally returned	Cardholder’s last name. Allowable Values: 40 char max
data[].metadata object Conditionally returned	Associates any additional metadata you provide with the cardholder. Allowable Values: You can define the names and values of up to 20 fields in the format `"my_name_1": "my_value_1"`
data[].middle_name string Conditionally returned	Cardholder’s middle name. Allowable Values: 40 char max
data[].nationality string Conditionally returned	Cardholder’s nationality. Allowable Values: 255 char max
data[].notes string Conditionally returned	Any additional information pertaining to the cardholder. Allowable Values: 255 char max
data[].parent_token string Conditionally returned	Unique identifier of the parent user or business resource. Allowable Values: 1–36 chars
data[].passport_expiration_date string Conditionally returned	Expiration date of the cardholder’s passport. Allowable Values: Format: yyyy-MM-dd
data[].passport_number string Conditionally returned	Cardholder’s passport number. Allowable Values: 40 char max
data[].password string Conditionally returned	Password to the cardholder’s user account on the Marqeta platform. Allowable Values: 1–255 chars
data[].phone string Conditionally returned	Cardholder’s telephone number. Allowable Values: 255 char max
data[].postal_code string Conditionally returned	Postal code of the cardholder’s address. Allowable Values: 10 char max
data[].ssn string Conditionally returned	Cardholder’s Social Security Number (SSN). Allowable Values: Nine digits only, no delimiters.
data[].state string Conditionally returned	State or province where the cardholder resides. Allowable Values: 2 char max
data[].status string Conditionally returned	Specifies the status of the cardholder on the Marqeta platform. Allowable Values: `UNVERIFIED`, `LIMITED`, `ACTIVE`, `SUSPENDED`, `CLOSED`
data[].title string Conditionally returned	Professional title of the cardholder, such as Chief Comptroller. Allowable Values: 255 char max
data[].token string Conditionally returned	Unique identifier of the cardholder. Allowable Values: 1–36 chars
data[].uses_parent_account boolean Conditionally returned	Indicates whether the child shares balances with the parent (`true`), or the child’s balances are independent of the parent (`false`). Allowable Values: `true`, `false`
data[].zip string Conditionally returned	United States ZIP code of the cardholder’s address. Allowable Values: 10 char max
end_index integer Conditionally returned	Sort order index of the first resource in the returned array. This field is returned if there are resources in your returned array. Allowable Values: Any integer
is_more boolean Conditionally returned	A value of `true` indicates that more unreturned resources exist. A value of `false` indicates that no more unreturned resources exist. This field is returned if there are resources in your returned array. Allowable Values: `true`, `false`
start_index integer Conditionally returned	Sort order index of the first resource in the returned array. This field is returned if there are resources in your returned array. Allowable Values: Any integer

Sample response body

JSON

{
  "count": 1,
  "start_index": 0,
  "end_index": 0,
  "is_more": false,
  "data": [
    {
      "token": "my_child_user_01",
      "active": true,
      "password": "My_passw0rd",
      "phone": "510-555-1111",
      "metadata": {
        "my_name_1": "my_value_1",
        "my_name_2": "my_value_2"
      },
      "gender": "F",
      "email": "my_child_user_01@gmail.com",
      "address1": "1234 Lake Street",
      "city": "Berkeley",
      "state": "CA",
      "postal_code": "94702",
      "country": "US",
      "identifications": [
        {
          "type": "SSN",
          "value": "123456789"
        }
      ],
      "first_name": "First",
      "last_name": "Last",
      "birth_date": "1990-01-01",
      "parent_token": "my_business_01",
      "uses_parent_account": true,
      "created_time": "2024-10-20T17:50:36Z",
      "last_modified_time": "2024-10-20T17:50:36Z",
      "business_token": "my_business_01",
      "status": "ACTIVE"
    }
  ]
}