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
skipnumber
Example: 2
limitnumber
Example: 2
teamIdstring
Example: 1aea9899-3f43-4ea6-852a-dddddbbc48c5
namestring
Example: Team name
websitestring
Example: https://example-team-page.com
createdBystring
Example: d4be5783-5373-4cca-ac96-1021277c3336
addressstring
userIdstring
createdAtenum

Sort by..

Example: desc
Options: desc, asc
Responses
curl -L \
  --url '..//v1/teams'
{
  "count": 1,
  "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",
      "createdAt": "2022-05-25T16:17:01.797Z",
      "updatedAt": "2022-05-25T16:17:01.797Z",
      "socialMedia": "https://facebook.com/my-profile",
      "members": [
        {
          "address": "0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377",
          "userId": "abc123456"
        }
      ]
    }
  ]
}

Create a team

post

/v1/teams

Authorizations
Header parameters
Authorizationstringrequired

asduf823hf-sa98ehf938rh

x-account-walletstringrequired

0xd1afbab5cacb45491ce002a6026c1401340eae6a

x-account-useridstringrequired

5a945f88-1de8cb-c6a1b4-1314ebac6bd1

Body
logostring
Example: https://image.com/logo
bannerstring
Example: https://image.com/banner
descriptionstring
Example: Full team description
namestringrequired
Example: Team name
websitestring
Example: https://example-team-page.com
socialMediaobject[]
Example: https://facebook.com/my-profile
Responses
curl -L \
  --request POST \
  --url '..//v1/teams' \
  --header 'Authorization: text' \
  --header 'x-account-wallet: text' \
  --header 'x-account-userid: text' \
  --header 'Content-Type: application/json' \
  --data '{"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",
  "createdAt": "2022-05-25T16:17:01.797Z",
  "updatedAt": "2022-05-25T16:17:01.797Z",
  "socialMedia": "https://facebook.com/my-profile",
  "members": [
    {
      "address": "0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377",
      "userId": "abc123456"
    }
  ]
}

Update a team

patch

/v1/teams/{teamId}

Authorizations
Path parameters
teamIdstringrequired
Example: 1aea9899-3f43-4ea6-852a-dddddbbc48c5
Header parameters
Authorizationstringrequired

asduf823hf-sa98ehf938rh

x-account-walletstringrequired

0xd1afbab5cacb45491ce002a6026c1401340eae6a

x-account-useridstringrequired

5a945f88-1de8cb-c6a1b4-1314ebac6bd1

Body
logostring
Example: https://image.com/logo
bannerstring
Example: https://image.com/banner
descriptionstring
Example: Full team description
namestring
Example: Team name
websitestring
Example: https://example-team-page.com
socialMediaobject[]
Example: https://facebook.com/my-profile
membersobject[]required
Responses
curl -L \
  --request PATCH \
  --url '..//v1/teams/{teamId}' \
  --header 'Authorization: text' \
  --header 'x-account-wallet: text' \
  --header 'x-account-userid: text' \
  --header 'Content-Type: application/json' \
  --data '{"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":[{}]}'
{
  "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",
  "createdAt": "2022-05-25T16:17:01.797Z",
  "updatedAt": "2022-05-25T16:17:01.797Z",
  "socialMedia": "https://facebook.com/my-profile",
  "members": [
    {
      "address": "0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377",
      "userId": "abc123456"
    }
  ]
}

Returns a Team data

get

/v1/teams/{nameOrId}

Path parameters
nameOrIdstringrequired
Responses
curl -L \
  --url '..//v1/teams/{nameOrId}'
{
  "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",
  "createdAt": "2022-05-25T16:17:01.797Z",
  "updatedAt": "2022-05-25T16:17:01.797Z",
  "socialMedia": "https://facebook.com/my-profile",
  "members": [
    {
      "address": "0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377",
      "userId": "abc123456"
    }
  ]
}

Checks name availability

get

/v1/teams/{name}/availability

Path parameters
namestringrequired
Example: Team name
Responses
curl -L \
  --url '..//v1/teams/{name}/availability'
{
  "isAvailable": true
}

Returns a list of requested teams

get

/v1/teams-search/{searchText}

Path parameters
searchTextstringrequired
Query parameters
skipnumber
Example: 2
limitnumber
Example: 2
Responses
curl -L \
  --url '..//v1/teams-search/{searchText}'
{
  "count": 1,
  "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",
      "createdAt": "2022-05-25T16:17:01.797Z",
      "updatedAt": "2022-05-25T16:17:01.797Z",
      "socialMedia": "https://facebook.com/my-profile",
      "members": [
        {
          "address": "0x3203c9e46ca618c8c1ce5dc67e7e9d75f5da2377",
          "userId": "abc123456"
        }
      ]
    }
  ]
}
PreviousUsers service NextApps service

Last updated