latestOpenAPI 3.1.02026-08-10128060.0 KB

5b916374c3f8

WorldBuilder
public

Get Mod

Retrieves a mod and its associated content using the mod's modId. The response also includes the user's write access permissions for the mod.

get/mods/{modId}/

Path parameters

modIdstring required

Query parameters

limitnumber

Number of documents to return per page

startAfterstring

Unique id of the returned value object that the query should start after

endBeforestring

Unique id of the returned value object that the query should end before

fieldstring required

Field to order by. Allows nesting with dot notation, e.g. if a field is nested in an object, use 'object.field'

fieldstring

Field to search by. Allows nesting with dot notation, e.g. if a field is nested in an object, use 'object.field'

prefixstring

Prefix to search for. NOTE: Prefix searching is case sensitive.

filterByobject

Filter by field and values.

Headers

x-m2-organization-idstring required

The ID of an organization

x-m2-project-idstring required

The ID of a project

Response

The response when getting a mod