Search teams

GET 
https://whatpulse.test/api/v1/teams

Search for teams by name. Returns a paginated list of teams matching the search criteria. Only public team information (ID and name) is returned. The search is case-insensitive and matches partial team names.

Request

Query Parameters

search string
per_page string

Responses

200

application/json

Schema

Schema

teams object[]required
Array [
idintegerrequired
The unique identifier for the team.
namestringrequired
The name of the team.
slugstringrequired
The slug of the team, used in URLs.
]
pagination objectrequired

current_pageintegerrequired

The current page number in the paginated result.

per_pageintegerrequired

The number of items per page in the paginated result.

totalintegerrequired

The total number of items across all pages.

last_pageintegerrequired

The total number of pages available in the paginated result.

fromintegerrequired

The starting item index for the current page.

tointegerrequired

The ending item index for the current page.

links objectrequired

firststringrequired

The URL for the first page of results.

laststringrequired

The URL for the last page of results.

prevstring | nullnullablerequired

The URL for the previous page of results, or null if there is no previous page.

nextstring | nullnullablerequired

The URL for the next page of results, or null if there is no next page. If you're paginating, you can call this url to get the next page of results.

filters objectrequired
searchstringrequired

Example (auto)

{
  "teams": [
    {
      "id": 0,
      "name": "string",
      "slug": "string"
    }
  ],
  "pagination": {
    "current_page": 0,
    "per_page": 0,
    "total": 0,
    "last_page": 0,
    "from": 0,
    "to": 0
  },
  "links": {
    "first": "string",
    "last": "string"
  },
  "filters": {
    "search": "string"
  }
}

401

Unauthenticated

application/json

Schema

Schema

messagestringrequired

Error overview.

Example (auto)

{
  "message": "string"
}

Authorization: http

name: httptype: httpscheme: bearer

• go
• java
• javascript
• kotlin
• nodejs
• objective-c
• php
• powershell
• python
• r
• ruby
• rust
• swift

• NATIVE

package main

import (
  "fmt"
  "net/http"
  "io"
)

func main() {

  url := "https://whatpulse.test/api/v1/teams"
  method := "GET"

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, nil)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Accept", "application/json")
  req.Header.Add("Authorization", "Bearer <token>")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := io.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}

Request Collapse all

Base URL

https://whatpulse.test/api/v1

Auth

Bearer Token

Parameters

search — query

per_page — query

ResponseClear

Click the Send API Request button above and see the response here!