Teams service

The Teams API allows you to manage teams. You can create teams, update their information, and retrieve team data. Additionally, you can check the availability of team names and retrieve a list of teams. This API provides essential functionalities for organizing and collaborating with your application, making it easier to manage teams and access relevant team data.

Swagger docs link:

https://api.metaproprotocol.com/ms/teams/docs

Returns a list of Teams

get
Query parameters
skipnumberOptionalExample: 2
limitnumber · min: 1OptionalExample: 2
teamIdstring · min: 40 · max: 60OptionalExample: 1aea9899-3f43-4ea6-852a-dddddbbc48c5
namestring · min: 2 · max: 100OptionalExample: Team name
websitestring · max: 600OptionalExample: https://example-team-page.com
createdBystringOptionalExample: d4be5783-5373-4cca-ac96-1021277c3336
addressstring · min: 35 · max: 55Optional
userIdstringOptional
createdAtstring · enumOptional

Sort by..

Example: descPossible values:
Responses
200Success
application/json
get
GET /teams HTTP/1.1
Host: v1
Accept: */*

{
  "results": [
    {
      "teamId": "1aea9899-3f43-4ea6-852a-dddddbbc48c5",
      "logo": "https://image.com/logo",
      "banner": "https://image.com/banner",
      "description": "Full team description",
      "name": "Team name",
      "website": "https://example-team-page.com",
      "createdBy": "d4be5783-5373-4cca-ac96-1021277c3336",
      "socialMedia": "https://facebook.com/my-profile",
      "createdAt": "2022-05-25T16:17:01.797Z",
      "updatedAt": "2022-05-25T16:17:01.797Z",
      "members": [
        {
          "address": "0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377",
          "userId": "abc123456"
        }
      ]
    }
  ],
  "count": 1
}

Create a team

post
Authorizations
Header parameters
AuthorizationstringRequired

asduf823hf-sa98ehf938rh

x-account-walletstringRequired

0xd1afbab5cacb45491ce002a6026c1401340eae6a

x-account-useridstringRequired

5a945f88-1de8cb-c6a1b4-1314ebac6bd1

Body
logostring · max: 255OptionalExample: https://image.com/logo
bannerstring · max: 255OptionalExample: https://image.com/banner
descriptionstring · max: 300OptionalExample: Full team description
namestring · min: 2 · max: 100RequiredExample: Team name
websitestring · max: 600OptionalExample: https://example-team-page.com
socialMediaobject[]OptionalExample: https://facebook.com/my-profile
Responses
200Success
application/json
post
POST /teams HTTP/1.1
Host: v1
Authorization: text
x-account-wallet: text
x-account-userid: text
Content-Type: application/json
Accept: */*
Content-Length: 216

{
  "logo": "https://image.com/logo",
  "banner": "https://image.com/banner",
  "description": "Full team description",
  "name": "Team name",
  "website": "https://example-team-page.com",
  "socialMedia": "https://facebook.com/my-profile"
}
{
  "teamId": "1aea9899-3f43-4ea6-852a-dddddbbc48c5",
  "logo": "https://image.com/logo",
  "banner": "https://image.com/banner",
  "description": "Full team description",
  "name": "Team name",
  "website": "https://example-team-page.com",
  "createdBy": "d4be5783-5373-4cca-ac96-1021277c3336",
  "socialMedia": "https://facebook.com/my-profile",
  "createdAt": "2022-05-25T16:17:01.797Z",
  "updatedAt": "2022-05-25T16:17:01.797Z",
  "members": [
    {
      "address": "0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377",
      "userId": "abc123456"
    }
  ]
}

Update a team

patch
Authorizations
Path parameters
teamIdstring · min: 40 · max: 60RequiredExample: 1aea9899-3f43-4ea6-852a-dddddbbc48c5
Header parameters
AuthorizationstringRequired

asduf823hf-sa98ehf938rh

x-account-walletstringRequired

0xd1afbab5cacb45491ce002a6026c1401340eae6a

x-account-useridstringRequired

5a945f88-1de8cb-c6a1b4-1314ebac6bd1

Body
logostring · max: 255OptionalExample: https://image.com/logo
bannerstring · max: 255OptionalExample: https://image.com/banner
descriptionstring · max: 300OptionalExample: Full team description
namestring · min: 2 · max: 100OptionalExample: Team name
websitestring · max: 600OptionalExample: https://example-team-page.com
socialMediaobject[]OptionalExample: https://facebook.com/my-profile
Responses
200Success
application/json
patch
PATCH /teams/{teamId} HTTP/1.1
Host: v1
Authorization: text
x-account-wallet: text
x-account-userid: text
Content-Type: application/json
Accept: */*
Content-Length: 263

{
  "logo": "https://image.com/logo",
  "banner": "https://image.com/banner",
  "description": "Full team description",
  "name": "Team name",
  "website": "https://example-team-page.com",
  "socialMedia": "https://facebook.com/my-profile",
  "members": [
    {
      "address": "text",
      "userId": "text"
    }
  ]
}
{
  "teamId": "1aea9899-3f43-4ea6-852a-dddddbbc48c5",
  "logo": "https://image.com/logo",
  "banner": "https://image.com/banner",
  "description": "Full team description",
  "name": "Team name",
  "website": "https://example-team-page.com",
  "createdBy": "d4be5783-5373-4cca-ac96-1021277c3336",
  "socialMedia": "https://facebook.com/my-profile",
  "createdAt": "2022-05-25T16:17:01.797Z",
  "updatedAt": "2022-05-25T16:17:01.797Z",
  "members": [
    {
      "address": "0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377",
      "userId": "abc123456"
    }
  ]
}

Returns a Team data

get
Path parameters
nameOrIdstringRequired
Responses
200Success
application/json
get
GET /teams/{nameOrId} HTTP/1.1
Host: v1
Accept: */*

{
  "teamId": "1aea9899-3f43-4ea6-852a-dddddbbc48c5",
  "logo": "https://image.com/logo",
  "banner": "https://image.com/banner",
  "description": "Full team description",
  "name": "Team name",
  "website": "https://example-team-page.com",
  "createdBy": "d4be5783-5373-4cca-ac96-1021277c3336",
  "socialMedia": "https://facebook.com/my-profile",
  "createdAt": "2022-05-25T16:17:01.797Z",
  "updatedAt": "2022-05-25T16:17:01.797Z",
  "members": [
    {
      "address": "0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377",
      "userId": "abc123456"
    }
  ]
}

Checks name availability

get
Path parameters
namestring · min: 2 · max: 100RequiredExample: Team name
Responses
200Success
application/json
get
GET /teams/{name}/availability HTTP/1.1
Host: v1
Accept: */*

{
  "isAvailable": true
}

Returns a list of requested teams

get
Path parameters
searchTextstringRequired
Query parameters
skipnumberOptionalExample: 2
limitnumber · min: 1OptionalExample: 2
Responses
200Success
application/json
get
GET /teams-search/{searchText} HTTP/1.1
Host: v1
Accept: */*

{
  "results": [
    {
      "teamId": "1aea9899-3f43-4ea6-852a-dddddbbc48c5",
      "logo": "https://image.com/logo",
      "banner": "https://image.com/banner",
      "description": "Full team description",
      "name": "Team name",
      "website": "https://example-team-page.com",
      "createdBy": "d4be5783-5373-4cca-ac96-1021277c3336",
      "socialMedia": "https://facebook.com/my-profile",
      "createdAt": "2022-05-25T16:17:01.797Z",
      "updatedAt": "2022-05-25T16:17:01.797Z",
      "members": [
        {
          "address": "0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377",
          "userId": "abc123456"
        }
      ]
    }
  ],
  "count": 1
}
PreviousUsers service NextApps service

Last updated