Returns a list of User Accounts.
Filter | Description |
---|---|
active |
Flag to indicate if this is an active User Account on the vendor side. Defaults to true if the vendor does not support or provide this value. |
created_at |
The date this User Account was created |
email |
The email received from the connection |
first_name |
The first name of the user received from the connection |
has_user |
Flag to indicate if this User Account has a User. False indicates that it's an unlinked account |
id |
The ID of the User Account |
last_name |
The last name of the user received from the connection |
third_party_id |
The identifier for this User Account on the vendor side |
updated_at |
The date this User Account was last updated |
vendor_name |
The name of the vendor that this User Account is from |
Bad Request
Unauthorized
Forbidden
[- {
- "data": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "type": "string",
- "attributes": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "active": true,
- "created_at": "2019-08-24T14:15:22Z",
- "email": "string",
- "first_name": "string",
- "has_user": true,
- "last_name": "string",
- "third_party_id": "string",
- "vendor_name": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "relationships": { },
- "links": { }
}, - "includes": { }
}
]
Returns a single User Account by ID
Bad Request
Unauthorized
Forbidden
Resource not found
{- "data": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "type": "string",
- "attributes": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "active": true,
- "created_at": "2019-08-24T14:15:22Z",
- "email": "string",
- "first_name": "string",
- "has_user": true,
- "last_name": "string",
- "third_party_id": "string",
- "vendor_name": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "relationships": { },
- "links": { }
}, - "includes": { }
}
Links a User to a User Account.
Bad Request
Unauthorized
Forbidden
Resource not found
{- "data": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "type": "string",
- "attributes": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "active": true,
- "created_at": "2019-08-24T14:15:22Z",
- "email": "string",
- "first_name": "string",
- "has_user": true,
- "last_name": "string",
- "third_party_id": "string",
- "vendor_name": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "relationships": { },
- "links": { }
}, - "includes": { }
}