Skip to content

Member

Query members of your organization.

Allowed query parameters

Filters

FilterTypeDescription
searchStringFull-text search

Sorting

name, created_at, position, department

Includes

user.media, supervisor.user.media

Retrieve a member

get
/member/{id}

Example response

json
// HTTP 200 OK
{
	"id": 123,
	"role": {
		"id": 1454,
		"name": "admin",
		"guard_name": "web",
		"created_at": "2022-05-19T09:35:09.000000Z",
		"updated_at": "2022-05-19T09:35:09.000000Z"
	},
	"name": "Alice Cooper",
	"user": {
		"id": 20,
		"firstname": "Alice",
		"lastname": "Cooper",
		"fullName": "Alice Cooper",
		"email": "alice.cooper@acme.com",
		"department": null,
		"description": null,
		"avatar": {
			"uuid": "40614a32-bdf8-41a5-808b-7bfec98eaef2",
			"name": "logo-only.png",
			"description": null,
			"mime_type": "image/png",
			"collection": "avatar",
			"url": "http://localhost:8000/image/40614a32-bdf8-41a5-808b-7bfec98eaef2/logo-only.png?fit=crop&h=100&w=100&signature=e6e65b38e9a91d58e428fa9007d98218a29abdd9d81fa514c1bfda364a348989"
		},
		"gravatar_url": "https://www.gravatar.com/avatar/8d3879333b5e88863ddbad18be8749bf?s=100&d=identicon&r=g"
	},
	"work_quota": 40
}

List members

get
/member

The list endpoint accepts the same parameters as in Retrieve a member and returns a paginated array of the same member object in the data property.

Read more about Pagination, Filtering, Sorting and Includes on the Introduction page.