Organisations
Get pending invitations for organisation
Mock APIs
Teams
Organisations
Data sources
Database connections
Usage
Access control
Stub Mappings
- GETGet all stub mappings
- POSTCreate a new stub mapping
- DELDelete all stub mappings
- POSTReset stub mappings
- POSTPersist stub mappings
- POSTImport stub mappings
- GETGet stub mapping by ID
- PUTUpdate a stub mapping
- DELDelete a stub mapping
- POSTFind stub mappings matching metadata
- POSTDelete stub mappings matching metadata
Requests
OpenAPI
Imports
Organisations
Get pending invitations for organisation
GET
/
v1
/
organisations
/
{organisationId}
/
invitations
curl --request GET \
--url https://wmc.wiremockapi.cloud/v1/organisations/{organisationId}/invitations \
--header 'Authorization: Basic <encoded-value>'
{
"invitations": [
{
"id": "neqek",
"senderId": "9gd5l",
"recipientEmailAddress": "tom+docsmember2@wiremock.io",
"newUser": true,
"role": "organisation_admin",
"created": "2024-10-30T19:28:23.802551Z",
"links": {
"self": "/v1/organisations/mgk7g/invitations/neqek"
}
}
]
}
Authorizations
Basic authentication header of the form Basic <encoded-value>
, where <encoded-value>
is the base64-encoded string username:password
.
Path Parameters
The ID of the organisation
Required string length:
5 - 10
Example:
"jjl8y"
Response
200 - application/json
Success
Example:
"neqek"
The ID of the user sending the invitation.
Example:
"9gd5l"
The email address of the user being invited.
Example:
"tom+docsmember2@wiremock.io"
Indicates whether the invited user already existed in the system.
Example:
true
The role of the new user within the organisation.
Available options:
organisation_admin
, organisation_member
Example:
"organisation_admin"
Example:
"2024-10-30T19:28:23.802551Z"
curl --request GET \
--url https://wmc.wiremockapi.cloud/v1/organisations/{organisationId}/invitations \
--header 'Authorization: Basic <encoded-value>'
{
"invitations": [
{
"id": "neqek",
"senderId": "9gd5l",
"recipientEmailAddress": "tom+docsmember2@wiremock.io",
"newUser": true,
"role": "organisation_admin",
"created": "2024-10-30T19:28:23.802551Z",
"links": {
"self": "/v1/organisations/mgk7g/invitations/neqek"
}
}
]
}