Skip to main content
Get Users
curl --request GET \
  --url https://api.yapily.com/users \
  --header 'Authorization: Basic <encoded-value>'
[
  {
    "uuid": "3b908179-6faa-42e1-8129-8fd0ff1fc68f",
    "applicationUuid": "3020bf54-e254-40ba-ba7b-fc959774486a",
    "applicationUserId": "string",
    "createdAt": "2022-10-17T08:51:02.463Z",
    "institutionConsents": [
      {
        "institutionId": "modelo-sandbox"
      }
    ]
  },
  {
    "uuid": "be7dd6fa-1236-41b6-a7a1-5d7863ab9553",
    "applicationUuid": "3020bf54-e254-40ba-ba7b-fc959774486a",
    "referenceId": "hollyhock@9tees.com",
    "createdAt": "2022-10-17T08:51:02.464Z",
    "institutionConsents": [
      {
        "institutionId": "mock-sandbox"
      }
    ]
  },
  {
    "uuid": "deb9aac1-b0bc-4f40-9c0b-6a675cf6646f",
    "applicationUuid": "3020bf54-e254-40ba-ba7b-fc959774486a",
    "referenceId": "beatrice@9tees.com",
    "createdAt": "2022-10-17T08:51:02.466Z",
    "institutionConsents": [
      {
        "institutionId": "yapily-mock"
      }
    ]
  }
]

Authorizations

​
Authorization
string
header
required

Use HTTP Basic Authentication with your Application ID as username and Application Secret as password. Manage credentials in the Yapily Console. See Authentication for details.

Query Parameters

​
filter[applicationUserId]
string[]

Optional. Filter records based on the list of applicationUserId users provided.

Response

Ok

​
uuid
string<uuid>

A unique identifier for the 'User' assigned by Yapily.

​
applicationUuid
string<uuid>

Unique identifier of the application the user is associated with.

​
applicationUserId
string

Conditional. The user-friendly reference to the User.

​
referenceId
string
​
createdAt
string<date-time>

Date and time of when the user was created.

​
institutionConsents
object[]
​
vopOptOut
boolean
default:false

Optional. A flag to indicate whether the user has opted out of VOP.