Skip to main content
GET
/
student
Python (SDK)
from meitner import Meitner, models
import os


with Meitner(
    security=models.Security(
        client_credentials=os.getenv("MEITNER_CLIENT_CREDENTIALS", ""),
        client_secret=os.getenv("MEITNER_CLIENT_SECRET", ""),
    ),
) as m_client:

    res = m_client.students.list(limit=1, offset=0)

    while res is not None:
        # Handle items

        res = res.next()
{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "meta": {
        "createdAt": "2024-01-15T10:30:00Z",
        "createdBy": "987fcdeb-51a2-43d1-b567-123456789abc",
        "updatedAt": "2024-01-15T14:45:00Z",
        "updatedBy": "987fcdeb-51a2-43d1-b567-123456789abc"
      },
      "external": {
        "sourceID": "12345678",
        "source": "ExternalIntegrationAPI"
      },
      "gender": "Female",
      "identityNumber": "20191216-1234",
      "identityTemporary": true,
      "firstName": "Lise",
      "lastName": "Meitner",
      "dateOfBirth": "2019-12-16",
      "address": {
        "postalAddress": "Dalvägen 14",
        "postalCode": "169 56",
        "postalCity": "Solna",
        "countryCode": "SWE",
        "municipalityCode": "0184"
      },
      "emailAddress1": "[email protected]",
      "emailAddress2": "[email protected]",
      "phoneNumber1": "+46701234567",
      "phoneNumber2": "example"
    }
  ],
  "pagination": {
    "offset": 0,
    "limit": 1,
    "total": 100
  }
}

Authorizations

​
Client-ID
string
header
required
​
Client-Secret
string
header
required

Query Parameters

​
limit
integer
default:50

The maximum number of Students to return (default: 50) when listing Students

Example:

1

​
offset
integer
default:0

The number of Students to skip before starting to return results (default: 0) when listing Students

Example:

0

Response

Response for Student List operation - returns a paginated list of Student

​
data
object[]

Array of Student objects

Example:
[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "meta": {
      "createdAt": "2024-01-15T10:30:00Z",
      "createdBy": "987fcdeb-51a2-43d1-b567-123456789abc",
      "updatedAt": "2024-01-15T14:45:00Z",
      "updatedBy": "987fcdeb-51a2-43d1-b567-123456789abc"
    },
    "external": {
      "sourceID": "12345678",
      "source": "ExternalIntegrationAPI"
    },
    "gender": "Female",
    "identityNumber": "20191216-1234",
    "identityTemporary": true,
    "firstName": "Lise",
    "lastName": "Meitner",
    "dateOfBirth": "2019-12-16",
    "address": {
      "postalAddress": "Dalvägen 14",
      "postalCode": "169 56",
      "postalCity": "Solna",
      "countryCode": "SWE",
      "municipalityCode": "0184"
    },
    "emailAddress1": "[email protected]",
    "emailAddress2": "[email protected]",
    "phoneNumber1": "+46701234567",
    "phoneNumber2": "example"
  }
]
​
pagination
object

Pagination information

Example:
{ "offset": 0, "limit": 1, "total": 100 }