Skip to content
Connect an agent
Organisations

Read where your publishes go

The organisations that claim the account's publishes, its default organisation, and where a publish that names no organisation goes now.

GET/user/publishing

TL;DR

QuestionAnswer
What does it do?Read where your publishes go.
What does it take?Nothing.
What does it return?Status 200 with a body of type UserPublishing.
What can go wrong?401 not signed in; 429 too many requests. Every failure uses the one error envelope.

What it does

The organisations that claim the account's publishes, its default organisation, and where a publish that names no organisation goes now.

Responses

StatusMeaningBody
200Where publishes go.UserPublishing
401Not signed in.ErrorResponse
429Too many requests.ErrorResponse

Response body

A 200 answer has the type UserPublishing.

FieldTypeRequiredDescription
defaultOrganizationanyyes
defaultOrganization.idstringyes
defaultOrganization.slugstringyes
defaultOrganization.namestringyes
organizationsPublishingClaim[]yesThe organisations whose Publishing setting claims the person's publishes, by name.
organizations[].idstringyes
organizations[].slugstringyes
organizations[].namestringyes
organizations[].policy"organisation-default" | "organisation-required"yesWhat it enforces: its library by default, or its library always.
organizations[].via"member" | "domain"yesmember when the person belongs to it; domain when it verified the domain of their address and they have not joined.
organizations[].canPublishbooleanyesWhether the person may publish to its library: a member who is not a reader.
targetPublishTargetyespersonal, the organisation it goes to and why, choose (several claim it and none is the default), or refused.

See also

DocWhy
API referenceEvery endpoint, and the error envelope
SchemasEvery request and response type
Tool referenceThe operations as callable tools