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..//v1/teams

Query parameters

Response

200400404

Body

application/json

results*array of Team (object)

count*number

Request

JavaScriptCurl

const response = await fetch('..//v1/teams', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "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": "0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377",
      "socialMedia": "https://facebook.com/my-profile",
      "createdAt": "2022-05-25T16:17:01.797Z",
      "updatedAt": "2022-05-25T16:17:01.797Z",
      "members": [
        {
          "address": "0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377"
        }
      ]
    }
  ],
  "count": 0
}

Create a team

POST..//v1/teams

Authorization

Authorization

Header parameters

Body

application/json

logostring

bannerstring

descriptionstring

name*string

websitestring

socialMediaarray of object

Response

200201400401403404

Body

application/json

teamId*string

logostring

bannerstring

descriptionstring

name*string

website*string

createdBy*string

socialMediaarray of object

createdAt*string (date-time)

updatedAt*string (date-time)

members*array of object

Request

JavaScriptCurl

const response = await fetch('..//v1/teams', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "Team name"
    }),
});
const data = await response.json();

Response

{
  "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": "0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377",
  "socialMedia": "https://facebook.com/my-profile",
  "createdAt": "2022-05-25T16:17:01.797Z",
  "updatedAt": "2022-05-25T16:17:01.797Z",
  "members": [
    {
      "address": "0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377"
    }
  ]
}

Update a team

PATCH..//v1/teams/{teamId}

Authorization

Authorization

Path parameters

teamId*string

Header parameters

Body

application/json

logostring

bannerstring

descriptionstring

namestring

websitestring

socialMediaarray of object

members*array of WalletAddress (object)

Response

200400401403404

Body

application/json

teamId*string

logostring

bannerstring

descriptionstring

name*string

website*string

createdBy*string

socialMediaarray of object

createdAt*string (date-time)

updatedAt*string (date-time)

members*array of object

Request

JavaScriptCurl

const response = await fetch('..//v1/teams/{teamId}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "members": [
        {
          "address": "text"
        }
      ]
    }),
});
const data = await response.json();

Response

{
  "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": "0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377",
  "socialMedia": "https://facebook.com/my-profile",
  "createdAt": "2022-05-25T16:17:01.797Z",
  "updatedAt": "2022-05-25T16:17:01.797Z",
  "members": [
    {
      "address": "0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377"
    }
  ]
}

Returns a Team data

GET..//v1/teams/{nameOrId}

Path parameters

nameOrId*string

Response

200400404

Body

application/json

teamId*string

logostring

bannerstring

descriptionstring

name*string

website*string

createdBy*string

socialMediaarray of object

createdAt*string (date-time)

updatedAt*string (date-time)

members*array of object

Request

JavaScriptCurl

const response = await fetch('..//v1/teams/{nameOrId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "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": "0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377",
  "socialMedia": "https://facebook.com/my-profile",
  "createdAt": "2022-05-25T16:17:01.797Z",
  "updatedAt": "2022-05-25T16:17:01.797Z",
  "members": [
    {
      "address": "0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377"
    }
  ]
}

Checks name availability

GET..//v1/teams/{name}/availability

Path parameters

name*string

Response

200400

Body

application/json

isAvailable*boolean

Request

JavaScriptCurl

const response = await fetch('..//v1/teams/{name}/availability', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "isAvailable": false
}

Returns a Team data

GET..//v1/users/{address}/teams

Path parameters

address*string

Query parameters

Response

200400404

Body

application/json

results*array of Team (object)

count*number

Request

JavaScriptCurl

const response = await fetch('..//v1/users/{address}/teams', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "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": "0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377",
      "socialMedia": "https://facebook.com/my-profile",
      "createdAt": "2022-05-25T16:17:01.797Z",
      "updatedAt": "2022-05-25T16:17:01.797Z",
      "members": [
        {
          "address": "0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377"
        }
      ]
    }
  ],
  "count": 0
}

Returns a list of requested teams

GET..//v1/teams-search/{searchText}

Path parameters

searchText*string

Query parameters

Response

200400404

Body

application/json

results*array of Team (object)

count*number

Request

JavaScriptCurl

const response = await fetch('..//v1/teams-search/{searchText}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "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": "0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377",
      "socialMedia": "https://facebook.com/my-profile",
      "createdAt": "2022-05-25T16:17:01.797Z",
      "updatedAt": "2022-05-25T16:17:01.797Z",
      "members": [
        {
          "address": "0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377"
        }
      ]
    }
  ],
  "count": 0
}